Sourced from Swashbuckle.AspNetCore.SwaggerGen's releases.

10.1.7

What's Changed

• Support custom data type for DataTypeAttribute by @​tayfunyuksel in Support custom data type for DataTypeAttribute domaindrivendev/Swashbuckle.AspNetCore#3868

New Contributors

• @​tayfunyuksel made their first contribution in Support custom data type for DataTypeAttribute domaindrivendev/Swashbuckle.AspNetCore#3868

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v10.1.6...v10.1.7

10.1.6

What's Changed

• Fix handling of duplicate enum values for dictionaries by @​martincostello in Fix handling of duplicate enum values for dictionaries domaindrivendev/Swashbuckle.AspNetCore#3839
• Log exception when app fails to start in CLI by @​ODukhno in Log exception when app fails to start in CLI domaindrivendev/Swashbuckle.AspNetCore#3853
• Fix missing OpenAPI 3.1 $ref properties by @​martincostello in Fix missing OpenAPI 3.1 $ref properties domaindrivendev/Swashbuckle.AspNetCore#3859
• Add description for OpenAPI schema references by @​martincostello in Add description for OpenAPI schema references domaindrivendev/Swashbuckle.AspNetCore#3860

New Contributors

• @​ODukhno made their first contribution in Log exception when app fails to start in CLI domaindrivendev/Swashbuckle.AspNetCore#3853

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v10.1.5...v10.1.6

10.1.5

What's Changed

• Bump swagger-ui-dist from 5.31.1 to 5.32.0 in /src/Swashbuckle.AspNetCore.SwaggerUI by @​dependabot in Bump swagger-ui-dist from 5.31.1 to 5.32.0 in /src/Swashbuckle.AspNetCore.SwaggerUI domaindrivendev/Swashbuckle.AspNetCore#3814
• Migrate to actions/attest by @​martincostello in Migrate to actions/attest domaindrivendev/Swashbuckle.AspNetCore#3815
• Disable secrets-outside-env audit by @​martincostello in Disable secrets-outside-env audit domaindrivendev/Swashbuckle.AspNetCore#3823
• Update zizmor to 1.23.1 by @​martincostello in Update zizmor to 1.23.1 domaindrivendev/Swashbuckle.AspNetCore#3825
• Fix null examples by @​jgarciadelanoceda in Fix nullExamples domaindrivendev/Swashbuckle.AspNetCore#3803
• Bump dependencies by @​martincostello in Bump dependencies domaindrivendev/Swashbuckle.AspNetCore#3835

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v10.1.4...v10.1.5

10.1.4

What's Changed

• Bump swagger-ui-dist from 5.31.0 to 5.31.1 in /src/Swashbuckle.AspNetCore.SwaggerUI by @​dependabot in Bump swagger-ui-dist from 5.31.0 to 5.31.1 in /src/Swashbuckle.AspNetCore.SwaggerUI domaindrivendev/Swashbuckle.AspNetCore#3792
• Return null on example, as it was with OpenApiNull before by @​jgarciadelanoceda in Return null on example, as it was with OpenApiNull before domaindrivendev/Swashbuckle.AspNetCore#3793

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v10.1.3...v10.1.4

10.1.3

What's Changed

• Fix null examples being represented as the string "null" by @​jgarciadelanoceda in Fix null examples being represented as the string null domaindrivendev/Swashbuckle.AspNetCore#3788

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v10.1.2...v10.1.3

10.1.2

What's Changed

• Fix browser caching behaviour by @​martincostello in Fix browser caching behaviour domaindrivendev/Swashbuckle.AspNetCore#3772
• Fix document URL serialization by @​martincostello in Fix document URL serialization domaindrivendev/Swashbuckle.AspNetCore#3773

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v10.1.1...v10.1.2

10.1.1

What's Changed

• Add cache headers to document URLs endpoint by @​Copilot and @​martincostello in Add cache headers to document URLs endpoint domaindrivendev/Swashbuckle.AspNetCore#3766

New Contributors

• @​Copilot made their first contribution in Add cache headers to document URLs endpoint domaindrivendev/Swashbuckle.AspNetCore#3766

Full Changelog:

domaindrivendev/Swashbuckle.AspNetCore@v10.1.0...v10.1.1

10.1.0

What's Changed

New Features

• Add public method SchemaRepository.ReplaceSchemaId by @​bkoelman in Add public method SchemaRepository.ReplaceSchemaId domaindrivendev/Swashbuckle.AspNetCore#3708

Bug Fixes

• Exclude inherited properties only when base added to AllOf by @​John-Paul-R in fix(SchemaGenerator): exclude inherited properties only when base add… domaindrivendev/Swashbuckle.AspNetCore#3692

Miscellaneous

• Add clarifying example in migration guide to v10 by @​markuspalme in Add clarifying example in migration guide to v10 domaindrivendev/Swashbuckle.AspNetCore#3672
• Add markdown linter by @​martincostello in Add markdown linter domaindrivendev/Swashbuckle.AspNetCore#3673
• Update dependencies by @​martincostello in Update dependencies domaindrivendev/Swashbuckle.AspNetCore#3685
• Validate OpenAPI documents create valid C# clients by @​martincostello in Validate OpenAPI documents create valid C# clients domaindrivendev/Swashbuckle.AspNetCore#3686
• End-to-end client validation tests by @​martincostello in End-to-end client validation tests domaindrivendev/Swashbuckle.AspNetCore#3687
• Add NSwag client test by @​martincostello in Add NSwag client test domaindrivendev/Swashbuckle.AspNetCore#3689
• Fix GitHub step summaries by @​martincostello in Fix GitHub step summaries domaindrivendev/Swashbuckle.AspNetCore#3691
• Clarify compatibility by @​martincostello in Clarify compatibility domaindrivendev/Swashbuckle.AspNetCore#3694
• Update zizmor by @​martincostello in Update zizmor domaindrivendev/Swashbuckle.AspNetCore#3695
• Suppress zizmor false-positive by @​martincostello in Suppress zizmor false-positive domaindrivendev/Swashbuckle.AspNetCore#3696
• Refactor tests by @​martincostello in Refactor tests domaindrivendev/Swashbuckle.AspNetCore#3705
• Use NuGet Trusted Publishing by @​martincostello in Use NuGet Trusted Publishing domaindrivendev/Swashbuckle.AspNetCore#3574
• Annotate TryLookupByType with nullability hints by @​martincostello in Annotate TryLookupByType for nullability domaindrivendev/Swashbuckle.AspNetCore#3719
• Bump swagger-ui-dist to 5.31.0 by @​dependabot in Bump swagger-ui-dist from 5.30.3 to 5.31.0 in /src/Swashbuckle.AspNetCore.SwaggerUI domaindrivendev/Swashbuckle.AspNetCore#3720

New Contributors

• @​markuspalme made their first contribution in Add clarifying example in migration guide to v10 domaindrivendev/Swashbuckle.AspNetCore#3672
• @​John-Paul-R made their first contribution in fix(SchemaGenerator): exclude inherited properties only when base add… domaindrivendev/Swashbuckle.AspNetCore#3692

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v10.0.1...v10.1.0

10.0.1

What's Changed

• Prepare for OpenAPI.NET 3.0 by @​martincostello in Prepare for OpenAPI.NET 3.0 domaindrivendev/Swashbuckle.AspNetCore#3647
• Fix exception sorting operation tags by @​martincostello in Fix exception sorting operation tags domaindrivendev/Swashbuckle.AspNetCore#3652
• Improve version table by @​martincostello in Improve version table domaindrivendev/Swashbuckle.AspNetCore#3653
• Update migration guide by @​martincostello in Update migration guide domaindrivendev/Swashbuckle.AspNetCore#3654

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v10.0.0...v10.0.1

10.0.0

Swashbuckle.AspNetCore v10.0.0

[!IMPORTANT]
This release contains major breaking changes.

Read our v10 migration guide for further information.

With this release, Swashbuckle.AspNetCore adds support for generating OpenAPI 3.1 documents and for ASP.NET Core 10.

Swashbuckle.AspNetCore v10 depends on OpenAPI.NET v2.3 which introduces many breaking changes to the public API surface. More information can be found in their OpenAPI.NET v2 Upgrade Guide.

To reduce the number of breaking behavioural changes in Swashbuckle.AspNetCore v10, generation of OpenAPI 3.1 documents is opt-in.
To generate OpenAPI 3.1 documents, change the OpenAPI version as shown in the code snippet below:

app.UseSwagger(options =>
{
    options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_1;
});

[!TIP]
It is strongly recommended that you upgrade to Swashbuckle.AspNetCore v9.0.6 before upgrading to v10.

[!IMPORTANT]
Use of Swashbuckle.AspNetCore with the ASP.NET Core WithOpenApi() method is no longer supported.

What's Changed

• Update README badges by @​martincostello in Update README badges domaindrivendev/Swashbuckle.AspNetCore#3597
• Extend NuGet package validation by @​martincostello in Extend NuGet package validation domaindrivendev/Swashbuckle.AspNetCore#3602
• Support .NET 10 by @​martincostello in Support .NET 10 domaindrivendev/Swashbuckle.AspNetCore#3283

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v9.0.6...v10.0.0

9.0.6

What's Changed

• Bump redoc from 2.5.0 to 2.5.1 by @​dependabot in Bump redoc from 2.5.0 to 2.5.1 in /src/Swashbuckle.AspNetCore.ReDoc domaindrivendev/Swashbuckle.AspNetCore#3587
• Bump swagger-ui from 5.29.1 to 5.29.2 by @​dependabot in Bump swagger-ui-dist from 5.29.1 to 5.29.2 in /src/Swashbuckle.AspNetCore.SwaggerUI domaindrivendev/Swashbuckle.AspNetCore#3595

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v9.0.5...v9.0.6

9.0.5

What's Changed

• .NET 10 preparation by @​martincostello in .NET 10 preparation domaindrivendev/Swashbuckle.AspNetCore#3565
• Update NuGet packages by @​martincostello in Update NuGet packages domaindrivendev/Swashbuckle.AspNetCore#3573
• Fix anchors by @​martincostello in Fix anchors domaindrivendev/Swashbuckle.AspNetCore#3577
• Bump swagger-ui-dist from 5.27.1 to 5.29.1

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v9.0.4...v9.0.5

9.0.4

What's Changed

• Fix incorrect ETag values by @​martincostello in Fix incorrect ETag values domaindrivendev/Swashbuckle.AspNetCore#3490
• Fix Accept-Encoding parsing by @​martincostello in Fix Accept-Encoding parsing domaindrivendev/Swashbuckle.AspNetCore#3492
• Check Accept-Encoding quality by @​martincostello in Check Accept-Encoding quality domaindrivendev/Swashbuckle.AspNetCore#3493
• Update xunit packages by @​martincostello in Update xunit packages domaindrivendev/Swashbuckle.AspNetCore#3500
• Add release notes configuration by @​martincostello in Add release notes configuration domaindrivendev/Swashbuckle.AspNetCore#3502
• Simplify release workflow by @​martincostello in Simplify release workflow domaindrivendev/Swashbuckle.AspNetCore#3503
• Bump xunit dependencies by @​martincostello in Bump xunit dependencies domaindrivendev/Swashbuckle.AspNetCore#3508
• Update NuGet dependencies by @​martincostello in Update NuGet dependencies domaindrivendev/Swashbuckle.AspNetCore#3513
• Remove WebHost usage from tests by @​martincostello in Remove WebHost usage domaindrivendev/Swashbuckle.AspNetCore#3517
• Fix typos by @​martincostello in Fix typos domaindrivendev/Swashbuckle.AspNetCore#3520
• Sign-off commits by @​martincostello in Sign-off commits domaindrivendev/Swashbuckle.AspNetCore#3526
• Add zizmor by @​martincostello in Add zizmor domaindrivendev/Swashbuckle.AspNetCore#3528
• Fix permissions by @​martincostello in Fix permissions domaindrivendev/Swashbuckle.AspNetCore#3529
• Bump zizmor by @​martincostello in Bump zizmor domaindrivendev/Swashbuckle.AspNetCore#3535
• Add default $type discriminator for [JsonPolymorphic] by @​lilinus in Default discriminator "$type" for JsonPolymorphicAttribute (annotations) domaindrivendev/Swashbuckle.AspNetCore#3496
• Update NuGet dependencies by @​martincostello in Update NuGet dependencies domaindrivendev/Swashbuckle.AspNetCore#3545

New Contributors

• @​lilinus made their first contribution in Default discriminator "$type" for JsonPolymorphicAttribute (annotations) domaindrivendev/Swashbuckle.AspNetCore#3496

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v9.0.3...v9.0.4

9.0.3

What's Changed

• Fix incorrect Content-Length for swagger-ui and Redoc static assets by @​martincostello in Fix incorrect Content-Length for swagger-ui and Redoc static assets domaindrivendev/Swashbuckle.AspNetCore#3488

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v9.0.2...v9.0.3

9.0.2

What's Changed

• Generate SBOM by @​martincostello in Generate SBOM domaindrivendev/Swashbuckle.AspNetCore#3468
• Compress swagger-ui and Redoc files in embedded resources with GZip by @​stratosblue in Using GZip to compress swagger-ui-dist files in embedded resource to reduce the output dll size domaindrivendev/Swashbuckle.AspNetCore#3399
• Refactor GZip compression by @​martincostello in Refactor GZip compression domaindrivendev/Swashbuckle.AspNetCore#3480

New Contributors

• @​stratosblue made their first contribution in Using GZip to compress swagger-ui-dist files in embedded resource to reduce the output dll size domaindrivendev/Swashbuckle.AspNetCore#3399

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v9.0.1...v9.0.2

9.0.1

What's Changed

• Fix missing Swashbuckle.AspNetCore metapackage dependencies by @​martincostello in Fix Swashbuckle.AspNetCore dependencies domaindrivendev/Swashbuckle.AspNetCore#3460

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v9.0.0...v9.0.1

9.0.0

📣 This release contains the following breaking changes:

• Drops support for netstandard2.0 and thus .NET Framework - now only net8.0 and net9.0 are supported.
• Removes all public members annotated as [Obsolete] in previous releases.
• Removes the deprecated --serializeasv2 option from Swashbuckle.AspNetCore.Cli, which was superseded by --openapiversion from version 8.0.0.

What's Changed

• Add tests for [Range] and respect ParseLimitsInInvariantCulture property by @​martincostello in Add tests for RangeAttribute and respect ParseLimitsInInvariantCulture property domaindrivendev/Swashbuckle.AspNetCore#3448
• Fix [Range] behaviour by @​martincostello in Fix RangeAttribute behaviour domaindrivendev/Swashbuckle.AspNetCore#3449
• Refactor sample websites by @​martincostello in Refactor sample websites domaindrivendev/Swashbuckle.AspNetCore#3450
• Drop netstandard support by @​martincostello in Drop netstandard support domaindrivendev/Swashbuckle.AspNetCore#3422

Full Changelog: domaindrivendev/Swashbuckle.AspNetCore@v8.1.4...v9.0.0

Commits viewable in compare view.